Documentation additions.
authorMatthias Clasen <matthiasc@src.gnome.org>
Sat, 5 Jan 2002 15:46:46 +0000 (15:46 +0000)
committerMatthias Clasen <matthiasc@src.gnome.org>
Sat, 5 Jan 2002 15:46:46 +0000 (15:46 +0000)
        * gtk/gtkwidget.c: Documentation additions.

        * gtk/tmpl/gtkwidget.sgml: Additions.

ChangeLog
ChangeLog.pre-2-0
ChangeLog.pre-2-10
ChangeLog.pre-2-2
ChangeLog.pre-2-4
ChangeLog.pre-2-6
ChangeLog.pre-2-8
docs/reference/ChangeLog
docs/reference/gtk/tmpl/gtkwidget.sgml
gtk/gtkwidget.c

index 316d83ae426bbfd833c7671a44ed8ab3ccb8509d..e43b72cacde3e4429a97574b7f402f2b39567ea3 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2001-01-04  Matthias Clasen  <matthiasc@poet.de>
+
+       * gtk/gtkwidget.c: Documentation additions.
+
 2001-01-04  Matthias Clasen  <matthiasc@poet.de>
 
        * gtk/gtkobject.c (gtk_object_dispose): Fix a comment.
index 316d83ae426bbfd833c7671a44ed8ab3ccb8509d..e43b72cacde3e4429a97574b7f402f2b39567ea3 100644 (file)
@@ -1,3 +1,7 @@
+2001-01-04  Matthias Clasen  <matthiasc@poet.de>
+
+       * gtk/gtkwidget.c: Documentation additions.
+
 2001-01-04  Matthias Clasen  <matthiasc@poet.de>
 
        * gtk/gtkobject.c (gtk_object_dispose): Fix a comment.
index 316d83ae426bbfd833c7671a44ed8ab3ccb8509d..e43b72cacde3e4429a97574b7f402f2b39567ea3 100644 (file)
@@ -1,3 +1,7 @@
+2001-01-04  Matthias Clasen  <matthiasc@poet.de>
+
+       * gtk/gtkwidget.c: Documentation additions.
+
 2001-01-04  Matthias Clasen  <matthiasc@poet.de>
 
        * gtk/gtkobject.c (gtk_object_dispose): Fix a comment.
index 316d83ae426bbfd833c7671a44ed8ab3ccb8509d..e43b72cacde3e4429a97574b7f402f2b39567ea3 100644 (file)
@@ -1,3 +1,7 @@
+2001-01-04  Matthias Clasen  <matthiasc@poet.de>
+
+       * gtk/gtkwidget.c: Documentation additions.
+
 2001-01-04  Matthias Clasen  <matthiasc@poet.de>
 
        * gtk/gtkobject.c (gtk_object_dispose): Fix a comment.
index 316d83ae426bbfd833c7671a44ed8ab3ccb8509d..e43b72cacde3e4429a97574b7f402f2b39567ea3 100644 (file)
@@ -1,3 +1,7 @@
+2001-01-04  Matthias Clasen  <matthiasc@poet.de>
+
+       * gtk/gtkwidget.c: Documentation additions.
+
 2001-01-04  Matthias Clasen  <matthiasc@poet.de>
 
        * gtk/gtkobject.c (gtk_object_dispose): Fix a comment.
index 316d83ae426bbfd833c7671a44ed8ab3ccb8509d..e43b72cacde3e4429a97574b7f402f2b39567ea3 100644 (file)
@@ -1,3 +1,7 @@
+2001-01-04  Matthias Clasen  <matthiasc@poet.de>
+
+       * gtk/gtkwidget.c: Documentation additions.
+
 2001-01-04  Matthias Clasen  <matthiasc@poet.de>
 
        * gtk/gtkobject.c (gtk_object_dispose): Fix a comment.
index 316d83ae426bbfd833c7671a44ed8ab3ccb8509d..e43b72cacde3e4429a97574b7f402f2b39567ea3 100644 (file)
@@ -1,3 +1,7 @@
+2001-01-04  Matthias Clasen  <matthiasc@poet.de>
+
+       * gtk/gtkwidget.c: Documentation additions.
+
 2001-01-04  Matthias Clasen  <matthiasc@poet.de>
 
        * gtk/gtkobject.c (gtk_object_dispose): Fix a comment.
index d8463a8e307951c35eeaf28deaa6cc6dcd568cf5..398ad79748c9ab0a9750ee62cd9a848c80432eda 100644 (file)
@@ -1,3 +1,7 @@
+2002-01-04  Matthias Clasen  <matthiasc@poet.de>
+
+       * gtk/tmpl/gtkwidget.sgml: Additions.
+
 2002-01-04  Matthias Clasen  <matthiasc@poet.de>
 
        * gtk/changes-1.2.sgml, gtk/changes-2.0.sgml: SGML fixes.
index 92cac33bb30c631d3778f2f536db44a85e03da2c..06617d5e958e335468410307a9b9390c62b4358b 100644 (file)
@@ -883,10 +883,10 @@ Turns off certain widget flags.
 
 <!-- ##### MACRO gtk_widget_set_rc_style ##### -->
 <para>
-
+Equivalent to <literal>gtk_widget_set_style (widget, NULL)</literal>.
 </para>
 
-@widget: 
+@widget: a #GtkWidget.
 
 
 <!-- ##### FUNCTION gtk_widget_ensure_style ##### -->
@@ -908,18 +908,18 @@ Turns off certain widget flags.
 
 <!-- ##### MACRO gtk_widget_restore_default_style ##### -->
 <para>
-
+Equivalent to <literal>gtk_widget_set_style (widget, NULL)</literal>.
 </para>
 
-@widget: 
+@widget: a #GtkWidget.
 
 
 <!-- ##### FUNCTION gtk_widget_reset_rc_styles ##### -->
 <para>
-
+Calls gtk_widget_set_rc_style() recursively on all descendants.
 </para>
 
-@widget: 
+@widget: a #GtkWidget. 
 
 
 <!-- ##### FUNCTION gtk_widget_push_colormap ##### -->
index 49e1205a84a3fe13bdc8c2307385448f1c2c9042..7f8a4fb65814bdac64fd63e44ca2a27d6e17f5f9 100644 (file)
@@ -1338,6 +1338,12 @@ gtk_widget_child_notify (GtkWidget    *widget,
   g_object_unref (widget);
 }
 
+/**
+ * gtk_widget_thaw_child_notify:
+ * @widget: a #GtkWidget
+ *
+ * Reverts the effect of a previous call to gtk_widget_freeze_child_notify().
+ */ 
 void
 gtk_widget_thaw_child_notify (GtkWidget *widget)
 {
@@ -4249,6 +4255,14 @@ gtk_widget_reset_rc_styles (GtkWidget *widget)
   gtk_widget_set_style_recurse (widget, NULL);
 }
 
+/**
+ * gtk_widget_get_default_style:
+ * 
+ * Returns the default style used by all widgets initially.
+ * 
+ * Returns: the default style. This #GtkStyle object is owned by GTK+ and
+ * should not be modified or freed.
+ */ 
 GtkStyle*
 gtk_widget_get_default_style (void)
 {
@@ -6044,6 +6058,14 @@ gtk_widget_class_install_style_property (GtkWidgetClass *class,
   gtk_widget_class_install_style_property_parser (class, pspec, parser);
 }
 
+/**
+ * gtk_widget_style_get_property:
+ * @widget: a #GtkWidget
+ * @property_name: the name of a style property
+ * @value: location to return the property value 
+ *
+ * Gets the value of a style property of @widget.
+ */
 void
 gtk_widget_style_get_property (GtkWidget   *widget,
                               const gchar *property_name,
@@ -6089,6 +6111,17 @@ gtk_widget_style_get_property (GtkWidget   *widget,
   g_object_unref (widget);
 }
 
+/**
+ * gtk_widget_style_get_valist:
+ * @widget: a #GtkWidget
+ * @first_property_name: the name of the first property to get
+ * @var_args: a <type>va_list</type> of pairs of property names and
+ *     locations to return the property values, starting with the location
+ *     for @first_property_name.
+ * 
+ * Non-vararg variant of gtk_widget_style_get(). Used primarily by language 
+ * bindings.
+ */ 
 void
 gtk_widget_style_get_valist (GtkWidget   *widget,
                             const gchar *first_property_name,
@@ -6139,6 +6172,16 @@ gtk_widget_style_get_valist (GtkWidget   *widget,
   g_object_unref (widget);
 }
 
+/**
+ * gtk_widget_style_get:
+ * @widget: a #GtkWidget
+ * @first_property_name: the name of the first property to get
+ * @Varargs: pairs of property names and locations to 
+ *   return the property values, starting with the location for 
+ *   @first_property_name, terminated by %NULL.
+ *
+ * Gets the values of a multiple style properties of @widget.
+ */
 void
 gtk_widget_style_get (GtkWidget   *widget,
                      const gchar *first_property_name,